home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / ZCATALOG.PY < prev    next >
Encoding:
Text File  |  2000-07-03  |  7.0 KB  |  217 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85.  
  86. def manage_addZCatalog(self, id, title, vocab_id=None):
  87.     """
  88.  
  89.     Add a ZCatalog object.
  90.  
  91.     'vocab_id' is the name of a Vocabulary object this catalog should
  92.     use.  A value of None will cause the Catalog to create its own
  93.     private vocabulary.
  94.  
  95.     """
  96.  
  97.  
  98.  
  99.  
  100. class ZCatalog:
  101.     """
  102.  
  103.     ZCatalog object
  104.  
  105.     A ZCatalog contains arbitrary index like references to Zope
  106.     objects.  ZCatalog's can index either 'Field' values of object,
  107.     'Text' values, or 'KeyWord' values:
  108.  
  109.     Indexes
  110.  
  111.       Text -- Text indexes index textual content.  The index can be
  112.       used to search for objects containing certain words.
  113.  
  114.       Field -- Field indexes index atomic values.  The index can be
  115.       used to search for objects that have certain properties.
  116.  
  117.       Keyword -- Keyword indexes index sequences of values.  The index
  118.       can be used to search for objects that match one or more of the
  119.       search terms.
  120.  
  121.     Meta-data
  122.  
  123.       The ZCatalog can maintain a table of extra data about cataloged
  124.       objects.  This information can be used on search result pages to
  125.       show information about a search result.
  126.  
  127.       The meta-data table schema is used to build the schema for
  128.       ZCatalog Result objects.  The objects have the same attributes
  129.       as the column of the meta-data table.
  130.  
  131.     ZCatalog does not store references to the objects themselves, but
  132.     rather to a unique identifier that defines how to get to the
  133.     object.  In Zope, this unique identifier is the object's relative
  134.     path to the ZCatalog (since two Zope object's cannot have the same 
  135.     URL, this is an excellent unique qualifier in Zope).
  136.  
  137.     """
  138.  
  139.     __constructor__=manage_addZCatalog
  140.  
  141.     def catalog_object(self, obj, uid):
  142.         """
  143.  
  144.         Catalogs the object 'obj' with the unique identifier 'uid'.
  145.  
  146.         """
  147.  
  148.     def uncatalog_object(self, uid):
  149.         """
  150.  
  151.         Uncatalogs the object with the unique identifier 'uid'.
  152.  
  153.         """
  154.  
  155.     def uniqueValuesFor(self, name):
  156.         """
  157.  
  158.         returns the unique values for a given FieldIndex named 'name'.
  159.  
  160.         """
  161.  
  162.     def getpath(self, rid):
  163.         """
  164.         
  165.         Return the path to a cataloged object given a
  166.         'data_record_id_'
  167.         
  168.         """
  169.  
  170.  
  171.     def getobject(self, rid, REQUEST=None):
  172.         """
  173.         
  174.         Return a cataloged object given a 'data_record_id_'
  175.         
  176.         """
  177.  
  178.     def schema(self):
  179.         """
  180.  
  181.         Returns a sequence of names that correspond to columns in the
  182.         meta-data table.
  183.  
  184.         """
  185.  
  186.     def indexes(self):
  187.         """
  188.  
  189.         Returns a sequence of names that correspond to indexes.
  190.  
  191.         """
  192.  
  193.     def index_objects(self):
  194.         """
  195.  
  196.         Returns a sequence of actual index objects.
  197.  
  198.         """
  199.  
  200.     def searchResults(self, REQUEST=None, **kw):
  201.         """
  202.         
  203.         Search the catalog.  Search terms can be passed in the REQUEST
  204.         or as keyword arguments.
  205.  
  206.         
  207.         XXX search grammar, how terms are combined, special search
  208.         terms, format of returned results XXX
  209.  
  210.         """
  211.     
  212.     def __call__(self, REQUEST=None, **kw):
  213.         """
  214.         Search the catalog, the same way as 'searchResults'.
  215.         """
  216.  
  217.